Non TMF Biz Api
GET- CustomerMigrationInfo
/customerMigrationInfo[GET]
This operation retrieves migration info of the customer.
Request
URL
https://[localhost]:[port]/nontmf-biz/v1/{businessId}/customerMigrationInfo
Base URI Parameter
Name | Type | M/O | Description |
---|---|---|---|
businessId | string | M | businessId string M Business unit identifier. Example: "PR” |
Headers
Name | Type | M/O | Description |
---|---|---|---|
Correlation-ID | string | O | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Could be uuid value, Min 16 Characters Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b |
lob | string | O | The Line of Business Identifier currently available are: Enum: PREPAID, POSTPAID,FIXED Note : Mobile users: PREPAID, POSTPAID Fixed users : FIXED |
channelId | string | O | Channel to identify the business group. Eg:ivrB2C |
targetSystem | string | O | This data type to indicate target system name/id in your request. Example : matrixx |
Security Headers
Name | Type | M/O | Description |
---|---|---|---|
client_id | string | M | Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332 |
client_secret | string | M | Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43f |
Query Parameters
Name | Type | M/O | Description |
---|---|---|---|
serviceNumber | String | M | Service Number or SubscriptionNumber |
Response
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
Success Response
[ 200 ]
{
"phone_number": "13406434744",
"activation_date": "2023-07-17 14:26:18",
"auto_pay_flg": true,
"fraud_flg": true,
"migration_status": "not_started",
"population_date": "2023-07-17 14:26:18",
"account_status": "Active",
"customer_type": "B2C",
"PIN": "1234",
"rating_type": "Postpaid",
"salesforce_account_number": "0017d00001I2dZEAAZ",
"source_system": "ATT",
"subscription_id": "21513835_21515314"
}
Definitions
name | type | description | required |
---|---|---|---|
subscription_id | string | Subscription Number of the subscriber | N |
phone_number | string | phone number of the subscriber | N |
customer_type | string | customer type of the subscriber | N |
account_status | string | status of the account | N |
fraud_flg | boolean | fraud flag which indicates the flag | N |
PIN | string | pin of the device | N |
salesforce_account_number | string | associated salesforce account number | N |
migration_status | string | indicates the migration status of the customer | N |
rating_type | string | Indicates the line of business of the customer | N |
source_system | string | Source system of the customer | N |
auto_pay_flg | boolean | indicates the whether subscriber opted for autoPay | N |
population_date | string | The date on which the customer has been created. | N |
activation_date | string | The date on which the subscription has been activated | N |